Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

req-then

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

req-then

Simple http(s) request function, returning a promise.

  • 0.6.4
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

view on npm npm module downloads Dependency Status Coverage Status js-standard-style

req-then

Wraps node's built-in http(s) request function with a few extras:

  • Returns a promise, resolving to an object containing the data, node response and original request.
  • Automatically selects http or https transport depending on the input URL.
  • Cancellable (which fetch is not).

Example

const request = require('req-then')

request('http://www.bbc.co.uk')
  .then(response => {
    console.log('Response data received', response.data)
    console.log('The original request options', response.req)
    console.log('The nodejs response instance', response.res)
  })
  .catch(console.error)

Example

const request = require('req-then')
const url = require('url')
const reqOptions = url.parse('http://www.bbc.co.uk')
const controller = {}
reqOptions.controller = controller
request(reqOptions)
  .then(response => {
    console.log('Response data received', response.data)
  })

// kill the request and close the socket
controller.abort()

request(reqOptions, [data]) ⇒ external:Promise

Returns a promise for the response.

Kind: Exported function
Resolve: object - res will be the node response object, data will be the data, req the original request.
Reject: Error - If aborted, the name property of the error will be aborted.

ParamTypeDescription
reqOptionsstring | objectTarget url string or a standard node.js http request options object.
[reqOptions.controller]objectIf supplied, an .abort() method will be created on it which, if invoked, will cancel the request. Cancelling will cause the returned promise to reject with an 'aborted' error.
[data]*Data to send with the request.

© 2015-17 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.

Keywords

FAQs

Package last updated on 29 Jun 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc